楽天ペイ都度決済 API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様（.idPass）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

EntryTranRakutenId 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID
JobCd		必須処理区分 AUTH：仮売上 CAPTURE：即時売上
Amount		必須半角数字8桁利用金額
Tax		半角数字8桁税送料税送料を指定した場合は、利用金額＋税送料が決済金額となります。利用金額＋税送料で100円以上99,999,999円以下である必要があります。

URL

/payment/EntryTranRakutenId.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=100

レスポンス

正常

OrderID		半角英数記号27桁オーダーID
AccessID		半角英数32桁固定取引ID
AccessPass		半角英数32桁固定取引パスワード

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranRakutenId 決済実行

これ以降の決済取引で必要となるトークンを返却します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
OrderID		必須半角英数記号27桁オーダーID
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
ItemId		必須半角英数記号100桁商品ID 取引情報として表示される商品IDを設定します。
ItemSubId		半角英数記号77桁商品サブID 取引情報として表示される商品サブIDを設定します。 ※加盟店様独自のポイントシステムがある場合必須です。
ItemName		必須全半角255バイト商品名取引情報として表示される商品名を設定します。
RetURL		必須半角英数記号2048桁決済結果戻しURL 加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。楽天ペイ上でお客様が決済手続きを正常に完了された場合に、指定されたURLに結果をリダイレクト経由で送信されます。
ErrorRcvURL		必須半角英数記号2048桁処理NG時URL 加盟店様が当サービスからの処理失敗となった結果を受信するための処理NG時URLを設定します。楽天ペイ上でお客様が決済手続きを正常に完了できなかった場合に、指定されたURLに結果をリダイレクト経由で送信されます。
PaymentTermSec		半角数字5桁支払開始期限秒お客様が【決済実行】から【支払手続き開始IF】を呼び出すまでの期限です。最大86,400秒（1日）呼び出しパラメータが空の場合、120秒で処理されます。
MultiItem		半角英数記号30000桁複数商品商品を複数指定する場合に設定します。 XMLフォーマットをUTF-8でBASE64エンコーディングした値を設定してください。複数商品の商品個数 X 商品単価と取引登録時の利用金額＋税送料は一致するよう設定してください。

URL

/payment/ExecTranRakutenId.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive/success&ErrorRcvURL=https://example.com/receive/error&ItemId=itemid001&ItemName=商品名

[XMLフォーマット]

UTF-8でBASE64エンコーディングした値を設定してください。

itemsInfo	商品情報親属性
item	商品複数指定することが可能です。
itemId	必須半角英数記号100桁商品ID 商品を特定する商品IDを設定します。 XML内で商品IDが重複した場合エラーとなります。
itemName	必須全半角255バイト商品名商品を特定する商品名を設定します。
itemNumbers	必須半角数字3桁商品個数商品の個数を設定します。
ItemFee	必須半角数字8桁商品単価商品単価を設定します。

XMLヘッダは不要です。
Base64エンコーディングする前のデータが30000バイト以内になるように設定してください。

[XMLサンプル]


<itemsInfo>
    <item>
        <itemId>ITEMID-001</itemId>
        <itemName>商品００１</itemName>
        <itemNumbers>5</itemNumbers>
        <itemFee>100</itemFee>
    </item>
    <item>
        <itemId>ITEMID-002</itemId>
        <itemName>商品００２</itemName>
        <itemNumbers>2</itemNumbers>
        <itemFee>80</itemFee>
    </item>
</itemsInfo>

レスポンス

正常

AccessID		半角英数32桁固定取引ID
Token		半角英数記号256桁固定トークンアクセスIDのハッシュ値を返却します。
StartURL		半角英数記号256桁支払手続き開始IFのURL 支払手続き開始IFのURLを返却します。
StartLimitDate		半角数字14桁固定支払開始期限日時支払手続き開始IFの呼び出し期限を返却します。 yyyyMMddHHmmss書式

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&Token=rT735NHvr5rGDDFsG/iMIoKv5SEiiINgsNuAZ4G2s+ewBS7yYvxSiC0zeMVH+O5A&StartURL=https://x01.mul-pay.jp/payment/RakutenIdStart.idPass&StartLimitDate=20190225162711

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

RakutenIdStart 支払手続き開始IFの呼び出し

楽天ペイにおいて、お客様を楽天ペイ画面へと遷移させる必要があります。
加盟店様のサイトから画面遷移させる場合は、お客様を当サービスの支払手続き開始IFに誘導してください。
当サービスは、お客様を楽天ペイ画面に誘導します。
※取引が特定できない場合、すでに支払いを済ませている場合、支払期限切れの場合等はエラー画面を表示します。

リクエスト

AccessID		必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
Token		必須半角英数256桁トークン【決済実行】で発行された値を設定します。

URL

/payment/RakutenIdStart.json

URL

/payment/RakutenIdStart.idPass

リダイレクトページサンプル


<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="RakutenIdStartCall" action="{決済実行のレスポンスで返却した接続先URL}" method="POST">
    <noscript>
      <br>
      <br>
      <center>
        <h2>
          楽天ペイ画面へ遷移します。
        </h2>
        <input type="submit" value="続行">
      </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
<input type="hidden" name="Token" value="{Token}">
    </form>
    <script >
    <!--
      function OnLoadEvent() {
        document. RakutenIdStartCall.submit();
      }
    //-->
    </script>
    </body>
</html>

決済結果受信

楽天ペイから、当サービスに支払操作結果が通知されます。
支払操作結果は、お客様が支払操作を完了した場合に通知されます。
当サービスは、【決済実行】時に指定されたリダイレクトURLに決済結果を通知します。
この決済結果は、楽天ペイの決済完了画面からブラウザ経由で連携されるため、お客様の操作方法によっては支払操作が完了したにもかかわらず、加盟店様に通知されないことがあります。
その際はショップ管理画面または結果通知にて確認ください。また、同様の理由でこの決済結果が複数回加盟店様に通知されることがあります。

レスポンス

正常

ShopID		必須半角英数13桁ショップID
OrderID		必須半角英数記号27桁オーダーID
c		必須半角英数32桁 MD5ハッシュチェック用の文字列(CheckString)を返却します。 ShopID＋OrderID＋ショップパスワードをMD5ハッシュした値を返却します。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

RakutenIdCancel 決済キャンセル

決済が完了した取引に対して決済内容のキャンセルを行います。
キャンセル可能な条件や期間は以下のとおりです。
・注文確定前の取引の場合、注文日の5ヵ月後の末日迄であること。
・注文確定後の取引の場合、注文確定の処理完了日から翌月末日迄であること。
・キャンセルは、1オーダーIDにつき１度のみ実行可能です。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
OrderID		必須半角英数記号27桁オーダーID

URL

/payment/RakutenIdCancel.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001

レスポンス

正常

OrderID		半角英数記号27桁オーダーID
Status		現状態キャンセル成功時は以下のステータスが返却されます。・REQCANCEL：注文キャンセル受付キャンセル失敗時はキャンセル処理前のステータスが返却されます。
Amount		半角数字8桁利用金額利用金額を返却します。
Tax		半角数字8桁税送料税送料を返却します。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=REQCANCEL&Amount=100&Tax=0

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

RakutenIdChange 決済金額変更

決済が完了した取引に対して決済内容の金額変更を行います。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
OrderID		必須半角英数記号27桁オーダーID
Amount		必須半角数字8桁変更利用金額指定の金額で利用金額を設定しなおします。
Tax		半角数字8桁変更税送料指定の金額で税送料を設定しなおします。
UseCoupon		半角数字1桁クーポン使用フラグ決済時に使用されたクーポンを金額変更時に使用するか否かを設定します。 0：使用しない 1：使用する未指定の場合は、クーポンが使用されていない取引は「0」、クーポンが使用された取引は「1」をデフォルトで使用します。 ※クーポンが使用されていない取引に対して「1」を指定するとエラーが発生します。 ※クーポンが利用された取引で「1」を指定した場合、変更利用金額がクーポン金額より少ないとエラーが発生します。
MultiItem		半角英数記号30000桁複数商品複数商品を指定する場合、設定してください。 XMLフォーマットをUTF-8でBASE64エンコーディングした値を設定してください。複数商品の商品個数 X 商品単価と変更利用金額＋変更税送料は一致するよう設定してください。決済実行時に複数商品を入力した場合は必須入力になります。決済実行時に複数商品を入力していない場合金額変更時に複数商品を入力することはできません。

URL

/payment/RakutenIdChange.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=100

[XMLフォーマット] 複数商品はUTF-8でBASE64エンコーディングした値を設定してください。

itemsInfo	商品情報親属性
item	商品複数指定することが可能です。
itemId	必須半角英数記号100桁商品ID 商品を特定する商品IDを設定します。決済実行時に設定した商品IDを設定してください。
itemNumbers	必須半角数字3桁商品個数変更する商品個数を設定します。変更しない場合は決済実行時又は直前の金額変更時に設定した商品個数を設定してください。商品を削除する場合は商品個数に0を設定してください。
ItemFee	必須半角数字8桁商品単価変更する商品単価を設定します。変更しない場合は決済実行時又は直前の金額変更時に設定した商品単価を設定してください。

XMLヘッダは不要です。
Base64エンコーディングする前のデータが30000バイト以内になるように設定してください。

[XMLサンプル]


<itemsInfo>
    <item>
        <itemId>ITEMID-001</itemId>
        <itemNumbers>5</itemNumbers>
        <itemFee>100</itemFee>
    </item>
    <item>
        <itemId>ITEMID-002</itemId>
        <itemNumbers>2</itemNumbers>
        <itemFee>80</itemFee>
    </item>
</itemsInfo>

レスポンス

正常

OrderID		半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
Status		現状態金額変更成功時は以下のステータスが返却されます。・REQCHANGE：金額変更受付金額変更失敗時は金額変更処理前のステータスが返却されます。
Amount		半角数字8桁利用金額利用金額を返却します。
Tax		半角数字8桁税送料税送料を返却します。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=REQCHANGE&Amount=100&Tax=0

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

RakutenIdSales 実売上

仮売上の決済に対して実売上を行います。
実売上可能な条件や期間は以下のとおりです。
・仮売として登録した取引であること。
・注文確定前の取引の場合、注文日の5ヵ月後の末日迄であること。（カードのオーソリ期限はオーソリから60日有効となりますが、オーソリ期限切れの決済に対しこの売上確定処理を行った場合は、楽天側で再オーソリを行った後、売上確定を行います。）

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
OrderID		必須半角英数記号27桁オーダーID

URL

/payment/RakutenIdSales.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001

レスポンス

正常

OrderID		半角英数記号27桁オーダーID
Status		現状態実売上成功時は以下のステータスが返却されます。・REQSALES：実売上受付実売上失敗時は実売上処理前のステータスが返却されます。
Amount		半角数字8桁利用金額実売上になった利用金額が返却されます。
Tax		半角数字8桁税送料実売上になった税送料が返却されます。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=REQSALES&Amount=100&Tax=0

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID
PayType		必須半角数字2桁決済方法 18：楽天ペイ

URL

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=18

レスポンス

正常

Status		現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 PAYSTART：決済開始 PAYFAIL：決済失敗 EXPIRED：期限切れ AUTH：仮売上 CAPTURE：即時売上 REQSALES：実売上受付 REQCANCEL：キャンセル受付 REQCHANGE：金額変更受付 SALES：実売上 CANCEL：キャンセル REGISTER：申込完了 REQAUTH：仮売上受付 REQCAPTURE：即時売上受付
ProcessDate		半角数字14桁固定処理日時 yyyyMMddHHmmss書式
AccessID		半角英数32桁固定取引ID
AccessPass		半角英数32桁固定取引パスワード
Amount		半角数字8桁利用金額
Tax		半角数字8桁税送料
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
PayType		半角数字2桁決済方法 18：楽天ペイ
JobCd		処理区分 AUTH：仮売上 CAPTURE：即時売上 REGISTER：申込
OrderDate		半角数字14桁固定注文日 yyyyMMddHHmmss書式
CompletionDate		半角数字8桁固定完了日売上確定、注文キャンセル、注文金額変更処理の完了日を返却します。 yyyyMMdd書式
RakutenidCouponFee		半角数字8桁クーポン金額決済時に使用されたクーポンの金額です。クーポンが使用されていない取引の場合、0になります。
SubscriptionId		サブスクリプションID
SettlementSubscriptionId		決済用サブスクリプションID

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

Status=AUTH&ProcessDate=20201225091313&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=100&Tax=8&ClientField1=&ClientField2=&ClientField3=&PayType=18&JobCd=AUTH&OrderDate=20201225091313&CompletionDate=20220801&RakutenidCouponFee=0&SubscriptionId=&SettlementSubscriptionId=

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ShopID		必須半角英数13桁ショップID
OrderID		必須半角英数記号27桁オーダーID
c		必須半角英数32桁 MD5ハッシュチェック用の文字列(CheckString)を返却します。 ShopID＋OrderID＋ショップパスワードをMD5ハッシュした値を返却します。

楽天ペイ(オンライン決済)